Update Client Invoice

PUT /tms/client-invoice/{uuid}

Description

This endpoint is used to update the details of a client invoice using the provided UUID. The update includes the estimated delivery date, status, and proof of delivery (POD) image URL.

Parameters

• uuid (string, path, required): The unique identifier of the client invoice.
• tenantId (string, header, required): The ID of the tenant.
• countryCode (string, header, required): The country code.

Request Body

• Media Type: application/json

Example Value

{
  "estimatedDeliveryDate": "2024-07-24T23:48:08.176Z",
  "status": "string",
  "podImageUrl": "string"
}

Responses

Success Response (200)

The Success Response (200) is returned when the client invoice is successfully updated. This response indicates the success of the operation and provides additional details.

Response Fields

Field	Type	Description
status	boolean	Indicates the success of the client invoice update request.
statusCode	integer	Numeric code representing the status of the response (e.g., 200 for success).
message	string	A message indicating the outcome of the operation.
data	object	Contains the updated client invoice details.
errors	array	An array of objects providing details about any errors encountered during the request.

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Client Invoice updated successfully",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Invalid Request Response (400)

The Invalid Request Response (400) is returned when the request is invalid. This response indicates that there was an issue with the request parameters or body.

Resource Not Found Response (404)

The Resource Not Found Response (404) is returned when the specified client invoice is not found. This response indicates that the provided UUID does not match any existing client invoices.